vcProcessFlowStep

Flow step is one step in flow group's sequence of steps and container for flow step properties. Flow step may contain one or more process groups.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcFeedOptionFlowInfo.FlowStep, vcGetFlowStepStatement.FlowStep, vcNextProcessFlowInfo.FlowStep, vcProcessFlowState.FlowStep, ... (see more)
vcFeedOptionFlowInfo.FlowStep
vcGetFlowStepStatement.FlowStep
vcNextProcessFlowInfo.FlowStep
vcProcessFlowState.FlowStep
vcProcessSequence.createStep()
vcProcessSequence.createStepFrom()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
GroupsvcObservableList[vcProcessGroup]RGets a list of process groups in the step.
IsOptionalBooleanRWGets or sets a value which defines if the products can potentially skip this flow step in their flow sequence.
NameStringRWGets or sets the name of flow step.
ProcessConfigurationsvcObservableList[vcFlowStepProcessConfiguration]RGets a read-only observable list of flow step process configuration instances,
affecting process group instances in this process flow step.
ProcessModevcProcessModeRWGets or sets a value which defines how products go through this flow step.
PropertiesvcPropertyContainerRGets the properties of this flow step.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
deleteNoneNoneDeletes this flow step instance.
endBatchNoneNoneEnds batch updating of groups and applies delayed updates to process configurations.
insertGroupvcProcessGroupvcProcessGroup group,
Optional Keyword[index = Integer]
Inserts the given process group into Groups.
See more
Parameters:
group (vcProcessGroup): A group to insert.
Optional: index (Integer): Index to insert the given group at. If index is omitted or out of range, the group is appended at the end of the list.
removeGroupNoneInteger indexRemoves the given process group from Groups.
See more
Parameters:
index (Integer): Zero based index of the group to remove.

Exceptions:
IndexError: When the given index is out of bounds.
startBatchNoneNoneStarts batch update of groups and delay updating process configurations until 'endBatch' is called.